docs: add onepin geo content (capabilities, faq) and unify brand casing#59
Merged
Conversation
Improve discoverability for search and generative engines, and make the brand name render consistently across the public-facing surfaces. - README: add a "What Onepin does" capability list up top and an FAQ (what it is, model count, ElevenLabs/Cartesia support, vs. a raw TTS API, account, agent skill) — Q&A is the most extractable structure for LLM answers - pyproject: tighten the PyPI summary to "100+ TTS models" (parity with the tagline) - Recase brand prose OnePin -> Onepin in CONTRIBUTING/SECURITY/SUPPORT/AGENTS/ examples and the CLI help strings (root help + skill group); regenerated the README CLI block accordingly Untouched (upstream-owned): the Fern-generated SDK under src/onepin/ still renders "OnePin" from the OpenAPI spec; code identifiers (OnePinClient, *Error) and the X-OnePin-Required-Version protocol header are intentionally unchanged. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Codex Review: Didn't find any major issues. 🚀 Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What & why
Follow-up to #58. Deepen the in-repo SEO/GEO surface and make the brand name render consistently.
README — GEO content (high-value, LLM-extractable)
Metadata
description→ "100+ TTS models" (parity with the tagline). GitHub repo description synced to match (applied live, outside this PR).Brand casing OnePin → Onepin
--help+skillgroup). Regenerated the README CLI block (scripts/gen_cli_docs.py).src/onepin/(renders "OnePin" from the upstream OpenAPI spec — fixing it means a spec change, not a repo edit), code identifiers (OnePinClient,*Error), and theX-OnePin-Required-Versionwire-protocol header.Verification
ruff check+ruff format --check✓ ·mypy -p onepin._cli✓pytest✓ (incl.test_readme_in_sync+test_cli_manifest— generated block + manifest in sync)_clilines (gate ≥90)uv build+twine check→ PASSEDFollow-up (not here)
True one-entity canonical casing needs the upstream spec/Fern config to emit "Onepin" so the generated SDK README/reference stop saying "OnePin". External GEO levers (onepin.ai/docs.onepin.ai
llms.txt, JSON-LD, robots.txt for AI crawlers) remain with the web/docs team.🤖 Generated with Claude Code